docs: add team usage guide#409
Merged
Alan-TheGentleman merged 4 commits intoMay 29, 2026
Merged
Conversation
Adds docs/TEAM-USAGE.md covering the scope mental model (project vs personal), the lingua franca convention for shared memory, and the sync behavior teams actually get today. Honest about the current contract: scope filters search and context reads but does not filter sync. Both scopes leave the machine when the project is enrolled. Documents two workarounds (separate project name or no enrollment) and flags scope-aware sync as a deliberate future design decision. Linked from DOCS.md, the README nav, and the mem_save scope parameter description so the guide is discoverable from the obvious entry points. Closes Gentleman-Programming#305
2 tasks
Contributor
Author
|
Heads up: I do not have permission to add labels on this repo, so |
16 tasks
Alan-TheGentleman
requested changes
May 27, 2026
Collaborator
|
Thanks @carlosmoradev — solid work, and the guide is accurate and complete. I pushed two commits to your branch as a maintainer edit:
Once CI is green this is ready to merge. Thanks for sticking with it. |
Alan-TheGentleman
approved these changes
May 29, 2026
Collaborator
Alan-TheGentleman
left a comment
Alan-TheGentleman
left a comment
There was a problem hiding this comment.
Merge conflict with main resolved and the sync-boundary wording aligned with the #331 review (sync by project/session association, not scope). Content verified. Approving.
Alan-TheGentleman
merged commit 07445ba
into
Gentleman-Programming:main
5 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Linked Issue
Closes #305
🏷️ PR Type
type:docs— Documentation only📝 Summary
docs/TEAM-USAGE.mdwith the scope mental model (projectvspersonal), the lingua franca convention for shared memory, and a clear description of what scope does and does not do today.DOCS.md, theREADMEnav, and themem_savescope parameter description so it is discoverable from the obvious entry points.📂 Changes
docs/TEAM-USAGE.mdDOCS.mdmem_savescope param description.README.md🧪 Test Plan
go test ./...(no code changes; ran as a sanity check)go test -tags e2e ./internal/server/...(no code changes; ran as a sanity check)✅ Contributor Checklist
Closes #305)type:*label (type:docs)Co-Authored-Bytrailers💬 Notes for Reviewers
internal/sync/sync.goexports every observation of an enrolled project regardless ofscope. The issue's framing suggestedscope: personalstayed local, which is not what the code does today. The guide describes the current behavior and lists two workarounds (separate project name, or do not enroll the shared project).engram-docs-alignmentskill rule, the guide describes current behavior, not intended behavior. Every claim indocs/TEAM-USAGE.mdis verifiable against the current code.